ShipHero GraphQL Public API
ShipHero’s public API provides access to platform data and operations for custom integrations. It is built on GraphQL, allowing clients to request exactly the fields they need for each workflow.
Latest Changes
2026 May 21st: Added the return_add_attachment mutation to attach files (images, PDFs, documents) to a return by providing a publicly accessible URL. Attachments can be linked to a specific return item via return_item_id for item-level documentation, or to the return as a whole when omitted.
2026 May 14th: Added the staged_inventory field on WholesaleLineItem, returning the staged manifest for a wholesale order — the SKUs, quantities, lots, container types, and bins currently in the staging location, broken down per line item. Use it after wholesale_order_transfer_picks_to_staging to know exactly what’s available to pack and to source the order_line_item_id values for wholesale_order_import_packing_layout. See the staged manifest step in the wholesale orders flow.
2026 May 13th: Added the Transfer Orders flow documenting how to mimic the UI’s transfer order behavior via the Public API by orchestrating order_create and purchase_order_create, including the tag conventions consumed by Multi‑Warehouse Allocation rules.
2026 April 22nd: Added the ad_hoc_charges query to retrieve ad-hoc charges by ID, and the bill_update_ad_hoc_charge mutation to modify existing ad-hoc charges on a customer’s 3PL billing.
2026 April 22nd: Added the item_locations query to retrieve item-bin records with rich filtering and cursor-based pagination. Supports filters like sku, location_name, location_name_prefix, has_inventory, pickable, sellable, location_type_id, and updated_from/updated_to for incremental sync. The response includes location, location_type, product, and expiration_lot fields.
2026 April 21st: Added cycle count queries and mutations: cycle_count and cycle_counts queries for retrieving cycle count batches, plus cycle_count_items_create, cycle_count_locations_create, and cycle_count_recount_create mutations for creating item-based, location-based, and recount cycle counts. See the Cycle Counts flow for detailed usage.